<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: transport/asio_local_stream_socket_fwd.hpp File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_0c017496b493ff066fbbe686970307ba.html">transport</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#namespaces">Namespaces</a> &#124;
<a href="#typedef-members">Typedefs</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">asio_local_stream_socket_fwd.hpp File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &quot;<a class="el" href="transport__fwd_8hpp_source.html">ipc/transport/transport_fwd.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="util__fwd_8hpp_source.html">ipc/util/util_fwd.hpp</a>&quot;</code><br />
<code>#include &quot;<a class="el" href="native__handle_8hpp_source.html">ipc/util/native_handle.hpp</a>&quot;</code><br />
<code>#include &lt;flow/log/log.hpp&gt;</code><br />
<code>#include &lt;boost/asio.hpp&gt;</code><br />
</div>
<p><a href="asio__local__stream__socket__fwd_8hpp_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="namespaces" name="namespaces"></a>
Namespaces</h2></td></tr>
<tr class="memitem:namespaceipc"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc.html">ipc</a></td></tr>
<tr class="memdesc:namespaceipc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Catch-all namespace for the Flow-IPC project: A library/API in modern C++17 providing high-performance communication between processes. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceipc_1_1transport"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport.html">ipc::transport</a></td></tr>
<tr class="memdesc:namespaceipc_1_1transport"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flow-IPC module providing transmission of structured messages and/or low-level blobs (and more) between pairs of processes. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceipc_1_1transport_1_1asio__local__stream__socket"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html">ipc::transport::asio_local_stream_socket</a></td></tr>
<tr class="memdesc:namespaceipc_1_1transport_1_1asio__local__stream__socket"><td class="mdescLeft">&#160;</td><td class="mdescRight">Additional (versus boost.asio) APIs for advanced work with local stream (Unix domain) sockets including transmission of native handles through such streams; and peer process credentials acquisition. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:namespaceipc_1_1transport_1_1asio__local__stream__socket_1_1local__ns"><td class="memItemLeft" align="right" valign="top">namespace &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket_1_1local__ns.html">ipc::transport::asio_local_stream_socket::local_ns</a></td></tr>
<tr class="memdesc:namespaceipc_1_1transport_1_1asio__local__stream__socket_1_1local__ns"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for boost.asio Unix domain socket namespace. <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a0ad6afc0bbf995a5b84528f96315f4a2"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a0ad6afc0bbf995a5b84528f96315f4a2">ipc::transport::asio_local_stream_socket::Protocol</a> = local_ns::stream_protocol</td></tr>
<tr class="memdesc:a0ad6afc0bbf995a5b84528f96315f4a2"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for boost.asio Unix domain stream-socket protocol.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a0ad6afc0bbf995a5b84528f96315f4a2">More...</a><br /></td></tr>
<tr class="separator:a0ad6afc0bbf995a5b84528f96315f4a2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a154986f10d30d850de86fc3924766e66"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a154986f10d30d850de86fc3924766e66">ipc::transport::asio_local_stream_socket::Acceptor</a> = Protocol::acceptor</td></tr>
<tr class="memdesc:a154986f10d30d850de86fc3924766e66"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for boost.asio Unix domain stream-socket acceptor (listening guy) socket.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a154986f10d30d850de86fc3924766e66">More...</a><br /></td></tr>
<tr class="separator:a154986f10d30d850de86fc3924766e66"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1788f9dbd896bb71b3693f9ae25b40ae"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a1788f9dbd896bb71b3693f9ae25b40ae">ipc::transport::asio_local_stream_socket::Peer_socket</a> = Protocol::socket</td></tr>
<tr class="memdesc:a1788f9dbd896bb71b3693f9ae25b40ae"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for boost.asio Unix domain peer stream-socket (usually-connected-or-empty guy).  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a1788f9dbd896bb71b3693f9ae25b40ae">More...</a><br /></td></tr>
<tr class="separator:a1788f9dbd896bb71b3693f9ae25b40ae"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a05656e297b98f4c370841d2f9be52a5f"><td class="memItemLeft" align="right" valign="top">using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a05656e297b98f4c370841d2f9be52a5f">ipc::transport::asio_local_stream_socket::Endpoint</a> = Protocol::endpoint</td></tr>
<tr class="memdesc:a05656e297b98f4c370841d2f9be52a5f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Short-hand for boost.asio Unix domain peer stream-socket endpoint.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a05656e297b98f4c370841d2f9be52a5f">More...</a><br /></td></tr>
<tr class="separator:a05656e297b98f4c370841d2f9be52a5f"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a68071e53f4a048084f8ad26ff3ac6711"><td class="memTemplParams" colspan="2">template&lt;typename Task_err &gt; </td></tr>
<tr class="memitem:a68071e53f4a048084f8ad26ff3ac6711"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a68071e53f4a048084f8ad26ff3ac6711">ipc::transport::asio_local_stream_socket::async_write_with_native_handle</a> (flow::log::Logger *logger_ptr, Peer_socket *peer_socket, Native_handle payload_hndl, const util::Blob_const &amp;payload_blob, Task_err &amp;&amp;on_sent_or_error)</td></tr>
<tr class="memdesc:a68071e53f4a048084f8ad26ff3ac6711"><td class="mdescLeft">&#160;</td><td class="mdescRight">boost.asio extension similar to <code>boost::asio::async_write(Peer_socket&amp;, Blob_const, Task_err_sz)</code> with the added capability of accompanying the <code>Blob_const</code> with a native handle to be transmitted to the opposing peer.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a68071e53f4a048084f8ad26ff3ac6711">More...</a><br /></td></tr>
<tr class="separator:a68071e53f4a048084f8ad26ff3ac6711"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1022dfd42e9a0d6eab8384b0352decb0"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a1022dfd42e9a0d6eab8384b0352decb0">ipc::transport::asio_local_stream_socket::nb_write_some_with_native_handle</a> (flow::log::Logger *logger_ptr, Peer_socket *peer_socket, Native_handle payload_hndl, const util::Blob_const &amp;payload_blob, Error_code *err_code)</td></tr>
<tr class="memdesc:a1022dfd42e9a0d6eab8384b0352decb0"><td class="mdescLeft">&#160;</td><td class="mdescRight">boost.asio extension similar to <code>peer_socket-&gt;non_blocking(true); auto n = peer_socket-&gt;write_some(payload_blob)</code> with the added capability of accompanying the <code>Blob_const payload_blob</code> with a native handle to be transmitted to the opposing peer.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a1022dfd42e9a0d6eab8384b0352decb0">More...</a><br /></td></tr>
<tr class="separator:a1022dfd42e9a0d6eab8384b0352decb0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ae82b2a234b218704c62fb616d6fcc5"><td class="memItemLeft" align="right" valign="top">size_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a9ae82b2a234b218704c62fb616d6fcc5">ipc::transport::asio_local_stream_socket::nb_read_some_with_native_handle</a> (flow::log::Logger *logger_ptr, Peer_socket *peer_socket, Native_handle *target_payload_hndl, const util::Blob_mutable &amp;target_payload_blob, Error_code *err_code, int message_flags=0)</td></tr>
<tr class="memdesc:a9ae82b2a234b218704c62fb616d6fcc5"><td class="mdescLeft">&#160;</td><td class="mdescRight">boost.asio extension similar to <code>peer_socket-&gt;non_blocking(true); auto n = peer_socket-&gt;read_some(target_payload_blob)</code> with the added capability of reading (from opposing peer) not only <code>Blob_mutable target_payload_blob</code> but an optionally accompanying native handle.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a9ae82b2a234b218704c62fb616d6fcc5">More...</a><br /></td></tr>
<tr class="separator:a9ae82b2a234b218704c62fb616d6fcc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acf7bdf0c727cbf0c5297125c762e1001"><td class="memTemplParams" colspan="2">template&lt;typename Task_err_blob , typename Target_payload_blob_func , typename Should_interrupt_func &gt; </td></tr>
<tr class="memitem:acf7bdf0c727cbf0c5297125c762e1001"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#acf7bdf0c727cbf0c5297125c762e1001">ipc::transport::asio_local_stream_socket::async_read_with_target_func</a> (flow::log::Logger *logger_ptr, Peer_socket *peer_socket, Target_payload_blob_func &amp;&amp;target_payload_blob_func, Should_interrupt_func &amp;&amp;should_interrupt_func, Task_err_blob &amp;&amp;on_rcvd_or_error)</td></tr>
<tr class="memdesc:acf7bdf0c727cbf0c5297125c762e1001"><td class="mdescLeft">&#160;</td><td class="mdescRight">boost.asio extension similar to <code>boost::asio::async_read(Peer_socket&amp;, Blob_mutable, Task_err_sz)</code> with the difference that the target buffer (<a class="el" href="namespaceipc_1_1util.html#a6cb62ae434900f3a8915b33ec5d61a96" title="Short-hand for an mutable blob somewhere in memory, stored as exactly a void* and a size_t.">util::Blob_mutable</a>) is determined by calling the arg-supplied function at the time when at least 1 byte is available to read, instead of the buffer being given direcly as an arg.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#acf7bdf0c727cbf0c5297125c762e1001">More...</a><br /></td></tr>
<tr class="separator:acf7bdf0c727cbf0c5297125c762e1001"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae811e863245b8226af4c40d373ed9a73"><td class="memTemplParams" colspan="2">template&lt;typename Task_err , typename Should_interrupt_func &gt; </td></tr>
<tr class="memitem:ae811e863245b8226af4c40d373ed9a73"><td class="memTemplItemLeft" align="right" valign="top">void&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#ae811e863245b8226af4c40d373ed9a73">ipc::transport::asio_local_stream_socket::async_read_interruptible</a> (flow::log::Logger *logger_ptr, Peer_socket *peer_socket, util::Blob_mutable target_payload_blob, Should_interrupt_func &amp;&amp;should_interrupt_func, Task_err &amp;&amp;on_rcvd_or_error)</td></tr>
<tr class="memdesc:ae811e863245b8226af4c40d373ed9a73"><td class="mdescLeft">&#160;</td><td class="mdescRight">boost.asio extension similar to <code>boost::asio::async_read(Peer_socket&amp;, Blob_mutable, Task_err_sz)</code> with the difference that it can be canceled/interrupted via <code>should_interrupt_func()</code> in the same way as the otherwise more complex <a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#acf7bdf0c727cbf0c5297125c762e1001" title="boost.asio extension similar to boost::asio::async_read(Peer_socket&amp;, Blob_mutable,...">async_read_with_target_func()</a>.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#ae811e863245b8226af4c40d373ed9a73">More...</a><br /></td></tr>
<tr class="separator:ae811e863245b8226af4c40d373ed9a73"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af0833f160dffd7f1c6921d27883a186b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#af0833f160dffd7f1c6921d27883a186b">ipc::transport::asio_local_stream_socket::release_native_peer_socket</a> (Native_handle &amp;&amp;peer_socket_native_or_null)</td></tr>
<tr class="memdesc:af0833f160dffd7f1c6921d27883a186b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Little utility that returns the raw Native_handle suitable for <a class="el" href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#a1788f9dbd896bb71b3693f9ae25b40ae" title="Short-hand for boost.asio Unix domain peer stream-socket (usually-connected-or-empty guy).">Peer_socket</a> to the OS.  <a href="namespaceipc_1_1transport_1_1asio__local__stream__socket.html#af0833f160dffd7f1c6921d27883a186b">More...</a><br /></td></tr>
<tr class="separator:af0833f160dffd7f1c6921d27883a186b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
